<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>aiengine: xaietile_proc.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">aiengine
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaietile__proc_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">xaietile_proc.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the variable and function prototypes for ELF loading. </p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who     Date     Changes
</p>
<hr/>
<p>
1.0  Hyun    08/17/2018  Initial creation
1.1  Nishad  12/05/2018  Renamed ME attributes to AIE
</pre> </div><table class="memberdecls">
<tr class="memitem:a00200ba9bd78b0129046b09adc0cd68f"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__proc_8h.html#a00200ba9bd78b0129046b09adc0cd68f">XAieTileProc_LoadElfFile</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr, u8 *ElfPtr, u8 LoadSym)</td></tr>
<tr class="memdesc:a00200ba9bd78b0129046b09adc0cd68f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the tile processor function to load an elf from a file.  <a href="#a00200ba9bd78b0129046b09adc0cd68f">More...</a><br/></td></tr>
<tr class="separator:a00200ba9bd78b0129046b09adc0cd68f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaabba0007d41464b8dff2a3411fb8490"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__proc_8h.html#aaabba0007d41464b8dff2a3411fb8490">XAieTileProc_LoadElfMem</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr, u8 *ElfPtr, u8 LoadSym)</td></tr>
<tr class="memdesc:aaabba0007d41464b8dff2a3411fb8490"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the tile processor function to load an elf from memory.  <a href="#aaabba0007d41464b8dff2a3411fb8490">More...</a><br/></td></tr>
<tr class="separator:aaabba0007d41464b8dff2a3411fb8490"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78b537661cfec3982de4d1d0147e1227"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__proc_8h.html#a78b537661cfec3982de4d1d0147e1227">XAieTileProc_Init</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr)</td></tr>
<tr class="memdesc:a78b537661cfec3982de4d1d0147e1227"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the tile processor function to initialize the remoteproc instance.  <a href="#a78b537661cfec3982de4d1d0147e1227">More...</a><br/></td></tr>
<tr class="separator:a78b537661cfec3982de4d1d0147e1227"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a1bd40bf7bba16dd183d2f842a18da3"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__proc_8h.html#a4a1bd40bf7bba16dd183d2f842a18da3">XAieTileProc_Finish</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr)</td></tr>
<tr class="memdesc:a4a1bd40bf7bba16dd183d2f842a18da3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the tile processor function to free the remoteproc instance.  <a href="#a4a1bd40bf7bba16dd183d2f842a18da3">More...</a><br/></td></tr>
<tr class="separator:a4a1bd40bf7bba16dd183d2f842a18da3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a4a1bd40bf7bba16dd183d2f842a18da3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAieTileProc_Finish </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the tile processor function to free the remoteproc instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr,:</td><td>Tile instance pointer of common AIE driver</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XAIELIB_SUCCESS on success, otherwise XAIELIB_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___tile.html#aeb4ec1804289eccd6a284e60b936ad18">XAieGbl_Tile::Private</a>.</p>

</div>
</div>
<a class="anchor" id="a78b537661cfec3982de4d1d0147e1227"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAieTileProc_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the tile processor function to initialize the remoteproc instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr,:</td><td>Tile instance pointer of common AIE driver</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XAIELIB_SUCCESS on success, otherwise XAIELIB_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___tile.html#aeb4ec1804289eccd6a284e60b936ad18">XAieGbl_Tile::Private</a>.</p>

<p>Referenced by <a class="el" href="xaielib_8h.html#aef3dab7b9235d8b5fd82fb51d0955286">XAieLib_InitTile()</a>.</p>

</div>
</div>
<a class="anchor" id="a00200ba9bd78b0129046b09adc0cd68f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAieTileProc_LoadElfFile </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>ElfPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LoadSym</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the tile processor function to load an elf from a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr,:</td><td>Tile instance pointer of common AIE driver </td></tr>
    <tr><td class="paramname">ElfPtr,:</td><td>a path to an elf file </td></tr>
    <tr><td class="paramname">LoadSym,:</td><td>UNUSED. Kept for compatibility</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XAIELIB_SUCCESS on success, otherwise XAIELIB_FAILURE. The return code is also passed from xaietileproc_load().</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="aaabba0007d41464b8dff2a3411fb8490"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAieTileProc_LoadElfMem </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>ElfPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LoadSym</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the tile processor function to load an elf from memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr,:</td><td>Tile instance pointer of common AIE driver </td></tr>
    <tr><td class="paramname">ElfPtr,:</td><td>pointer to elf in memory </td></tr>
    <tr><td class="paramname">LoadSym,:</td><td>UNUSED. Kept for compatibility</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XAIELIB_SUCCESS on success, otherwise XAIELIB_FAILURE. The return code is also passed from xaietileproc_load().</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
